<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>SqlExpression xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/torque/util/SqlExpression.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> <a href="../../../../org/apache/torque/util/package-summary.html">org.apache.torque.util</a>;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a>   <em class="comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="6" href="#6">6</a>   <em class="comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a>   <em class="comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="8" href="#8">8</a>   <em class="comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a>   <em class="comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a>  <em class="comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a>  <em class="comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a>  <em class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a>  <em class="comment"> * KIND, either express or implied.  See the License for the</em>
<a name="18" href="#18">18</a>  <em class="comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a>  <em class="comment"> * under the License.</em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> java.lang.reflect.Array;
<a name="23" href="#23">23</a>  <strong>import</strong> java.util.Date;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.HashSet;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.Iterator;
<a name="26" href="#26">26</a>  <strong>import</strong> java.util.List;
<a name="27" href="#27">27</a>  
<a name="28" href="#28">28</a>  <strong>import</strong> org.apache.commons.lang.StringUtils;
<a name="29" href="#29">29</a>  <strong>import</strong> org.apache.torque.TorqueException;
<a name="30" href="#30">30</a>  <strong>import</strong> org.apache.torque.adapter.DB;
<a name="31" href="#31">31</a>  <strong>import</strong> org.apache.torque.om.DateKey;
<a name="32" href="#32">32</a>  <strong>import</strong> org.apache.torque.om.ObjectKey;
<a name="33" href="#33">33</a>  <strong>import</strong> org.apache.torque.om.StringKey;
<a name="34" href="#34">34</a>  
<a name="35" href="#35">35</a>  
<a name="36" href="#36">36</a>  <em>/**<em>*</em></em>
<a name="37" href="#37">37</a>  <em> * This class represents a part of an SQL query found in the &lt;code>WHERE&lt;/code></em>
<a name="38" href="#38">38</a>  <em> * section.  For example:</em>
<a name="39" href="#39">39</a>  <em> * &lt;pre></em>
<a name="40" href="#40">40</a>  <em> * table_a.column_a = table_b.column_a</em>
<a name="41" href="#41">41</a>  <em> * column LIKE 'F%'</em>
<a name="42" href="#42">42</a>  <em> * table.column &lt; 3</em>
<a name="43" href="#43">43</a>  <em> * &lt;/pre></em>
<a name="44" href="#44">44</a>  <em> * This class is used primarily by {@link org.apache.torque.util.BasePeer}.</em>
<a name="45" href="#45">45</a>  <em> *</em>
<a name="46" href="#46">46</a>  <em> * @author &lt;a href="<a href="mailto:jmcnally@collab.net" target="alexandria_uri">mailto:jmcnally@collab.net</a>">John D. McNally&lt;/a></em>
<a name="47" href="#47">47</a>  <em> * @author &lt;a href="<a href="mailto:dlr@finemaltcoding.com" target="alexandria_uri">mailto:dlr@finemaltcoding.com</a>">Daniel Rall&lt;/a></em>
<a name="48" href="#48">48</a>  <em> * @author &lt;a href="<a href="mailto:fedor@apache.org" target="alexandria_uri">mailto:fedor@apache.org</a>">Fedor Karpelevitch&lt;/a></em>
<a name="49" href="#49">49</a>  <em> * @author &lt;a href="<a href="mailto:mpoeschl@marmot.at" target="alexandria_uri">mailto:mpoeschl@marmot.at</a>">Martin Poeschl&lt;/a></em>
<a name="50" href="#50">50</a>  <em> * @version $Id: SqlExpression.java 476550 2006-11-18 16:08:37Z tfischer $</em>
<a name="51" href="#51">51</a>  <em> */</em>
<a name="52" href="#52">52</a>  <strong>public</strong> <strong>final</strong> <strong>class</strong> <a href="../../../../org/apache/torque/util/SqlExpression.html">SqlExpression</a>
<a name="53" href="#53">53</a>  {
<a name="54" href="#54">54</a>      <em>/**<em>* escaped single quote */</em></em>
<a name="55" href="#55">55</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>char</strong> SINGLE_QUOTE = '\'';
<a name="56" href="#56">56</a>      <em>/**<em>* escaped backslash */</em></em>
<a name="57" href="#57">57</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>char</strong> BACKSLASH = '&#47;&#47;';
<a name="58" href="#58">58</a>  
<a name="59" href="#59">59</a>      <em>/**<em>*</em></em>
<a name="60" href="#60">60</a>  <em>     * Private constructor to prevent instantiation.</em>
<a name="61" href="#61">61</a>  <em>     *</em>
<a name="62" href="#62">62</a>  <em>     * Class contains only static method ans should therefore not be</em>
<a name="63" href="#63">63</a>  <em>     * instantiated.</em>
<a name="64" href="#64">64</a>  <em>     */</em>
<a name="65" href="#65">65</a>      <strong>private</strong> <a href="../../../../org/apache/torque/util/SqlExpression.html">SqlExpression</a>()
<a name="66" href="#66">66</a>      {
<a name="67" href="#67">67</a>      }
<a name="68" href="#68">68</a>  
<a name="69" href="#69">69</a>      <em>/**<em>*</em></em>
<a name="70" href="#70">70</a>  <em>     * Used to specify a join on two columns.</em>
<a name="71" href="#71">71</a>  <em>     *</em>
<a name="72" href="#72">72</a>  <em>     * @param column A column in one of the tables to be joined.</em>
<a name="73" href="#73">73</a>  <em>     * @param relatedColumn The column in the other table to be joined.</em>
<a name="74" href="#74">74</a>  <em>     * @return A join expression, e.g. UPPER(table_a.column_a) =</em>
<a name="75" href="#75">75</a>  <em>     *         UPPER(table_b.column_b).</em>
<a name="76" href="#76">76</a>  <em>     */</em>
<a name="77" href="#77">77</a>      <strong>public</strong> <strong>static</strong> String buildInnerJoin(String column, String relatedColumn)
<a name="78" href="#78">78</a>      {
<a name="79" href="#79">79</a>          <em class="comment">// 'db' can be null because 'ignoreCase' is false.</em>
<a name="80" href="#80">80</a>          <strong>return</strong> buildInnerJoin(column, relatedColumn, false, <strong>null</strong>);
<a name="81" href="#81">81</a>      }
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>      <em>/**<em>*</em></em>
<a name="84" href="#84">84</a>  <em>     * Used to specify a join on two columns.</em>
<a name="85" href="#85">85</a>  <em>     *</em>
<a name="86" href="#86">86</a>  <em>     * @param column A column in one of the tables to be joined.</em>
<a name="87" href="#87">87</a>  <em>     * @param relatedColumn The column in the other table to be joined.</em>
<a name="88" href="#88">88</a>  <em>     * @param ignoreCase If true and columns represent Strings, the appropriate</em>
<a name="89" href="#89">89</a>  <em>     *        function defined for the database will be used to ignore</em>
<a name="90" href="#90">90</a>  <em>     *        differences in case.</em>
<a name="91" href="#91">91</a>  <em>     * @param db Represents the database in use for vendor-specific functions.</em>
<a name="92" href="#92">92</a>  <em>     * @return A join expression, e.g. UPPER(table_a.column_a) =</em>
<a name="93" href="#93">93</a>  <em>     *         UPPER(table_b.column_b).</em>
<a name="94" href="#94">94</a>  <em>     */</em>
<a name="95" href="#95">95</a>      <strong>public</strong> <strong>static</strong> String buildInnerJoin(String column,
<a name="96" href="#96">96</a>                                           String relatedColumn,
<a name="97" href="#97">97</a>                                           <strong>boolean</strong> ignoreCase,
<a name="98" href="#98">98</a>                                           <a href="../../../../org/apache/torque/adapter/DB.html">DB</a> db)
<a name="99" href="#99">99</a>      {
<a name="100" href="#100">100</a>         <strong>int</strong> addlength = (ignoreCase) ? 25 : 1;
<a name="101" href="#101">101</a>         StringBuffer sb = <strong>new</strong> StringBuffer(column.length()
<a name="102" href="#102">102</a>                 + relatedColumn.length() + addlength);
<a name="103" href="#103">103</a>         buildInnerJoin(column, relatedColumn, ignoreCase, db, sb);
<a name="104" href="#104">104</a>         <strong>return</strong> sb.toString();
<a name="105" href="#105">105</a>     }
<a name="106" href="#106">106</a> 
<a name="107" href="#107">107</a>     <em>/**<em>*</em></em>
<a name="108" href="#108">108</a> <em>     * Used to specify a join on two columns.</em>
<a name="109" href="#109">109</a> <em>     *</em>
<a name="110" href="#110">110</a> <em>     * @param column A column in one of the tables to be joined.</em>
<a name="111" href="#111">111</a> <em>     * @param relatedColumn The column in the other table to be joined.</em>
<a name="112" href="#112">112</a> <em>     * @param ignoreCase If true and columns represent Strings, the appropriate</em>
<a name="113" href="#113">113</a> <em>     *        function defined for the database will be used to ignore</em>
<a name="114" href="#114">114</a> <em>     *        differences in case.</em>
<a name="115" href="#115">115</a> <em>     * @param db Represents the database in use for vendor-specific functions.</em>
<a name="116" href="#116">116</a> <em>     * @param whereClause A StringBuffer to which the sql expression will be</em>
<a name="117" href="#117">117</a> <em>     *        appended.</em>
<a name="118" href="#118">118</a> <em>     */</em>
<a name="119" href="#119">119</a>     <strong>public</strong> <strong>static</strong> <strong>void</strong> buildInnerJoin(String column,
<a name="120" href="#120">120</a>                                        String relatedColumn,
<a name="121" href="#121">121</a>                                        <strong>boolean</strong> ignoreCase,
<a name="122" href="#122">122</a>                                        <a href="../../../../org/apache/torque/adapter/DB.html">DB</a> db,
<a name="123" href="#123">123</a>                                        StringBuffer whereClause)
<a name="124" href="#124">124</a>     {
<a name="125" href="#125">125</a>         <strong>if</strong> (ignoreCase)
<a name="126" href="#126">126</a>         {
<a name="127" href="#127">127</a>             whereClause.append(db.ignoreCase(column))
<a name="128" href="#128">128</a>                     .append('=')
<a name="129" href="#129">129</a>                     .append(db.ignoreCase(relatedColumn));
<a name="130" href="#130">130</a>         }
<a name="131" href="#131">131</a>         <strong>else</strong>
<a name="132" href="#132">132</a>         {
<a name="133" href="#133">133</a>             whereClause.append(column)
<a name="134" href="#134">134</a>                     .append('=')
<a name="135" href="#135">135</a>                     .append(relatedColumn);
<a name="136" href="#136">136</a>         }
<a name="137" href="#137">137</a>     }
<a name="138" href="#138">138</a> 
<a name="139" href="#139">139</a> 
<a name="140" href="#140">140</a>     <em>/**<em>*</em></em>
<a name="141" href="#141">141</a> <em>     * Builds a simple SQL expression.</em>
<a name="142" href="#142">142</a> <em>     *</em>
<a name="143" href="#143">143</a> <em>     * @param columnName A column.</em>
<a name="144" href="#144">144</a> <em>     * @param criteria The value to compare the column against.</em>
<a name="145" href="#145">145</a> <em>     * @param comparison One of =, &amp;lt;, &amp;gt;, ^lt;=, &amp;gt;=, &amp;lt;&amp;gt;,</em>
<a name="146" href="#146">146</a> <em>     *        !=, LIKE, etc.</em>
<a name="147" href="#147">147</a> <em>     * @return A simple SQL expression, e.g. UPPER(table_a.column_a)</em>
<a name="148" href="#148">148</a> <em>     *         LIKE UPPER('ab%c').</em>
<a name="149" href="#149">149</a> <em>     * @throws TorqueException Any exceptions caught during processing will be</em>
<a name="150" href="#150">150</a> <em>     *         rethrown wrapped into a TorqueException.</em>
<a name="151" href="#151">151</a> <em>     */</em>
<a name="152" href="#152">152</a>     <strong>public</strong> <strong>static</strong> String build(String columnName,
<a name="153" href="#153">153</a>                                 Object criteria,
<a name="154" href="#154">154</a>                                 <a href="../../../../org/apache/torque/util/SqlEnum.html">SqlEnum</a> comparison)
<a name="155" href="#155">155</a>         throws <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>
<a name="156" href="#156">156</a>     {
<a name="157" href="#157">157</a>         <em class="comment">// 'db' can be null because 'ignoreCase' is null</em>
<a name="158" href="#158">158</a>         <strong>return</strong> build(columnName, criteria, comparison, false, <strong>null</strong>);
<a name="159" href="#159">159</a>     }
<a name="160" href="#160">160</a> 
<a name="161" href="#161">161</a>     <em>/**<em>*</em></em>
<a name="162" href="#162">162</a> <em>     * Builds a simple SQL expression.</em>
<a name="163" href="#163">163</a> <em>     *</em>
<a name="164" href="#164">164</a> <em>     * @param columnName A column.</em>
<a name="165" href="#165">165</a> <em>     * @param criteria The value to compare the column against.</em>
<a name="166" href="#166">166</a> <em>     * @param comparison One of =, &amp;lt;, &amp;gt;, ^lt;=, &amp;gt;=, &amp;lt;&amp;gt;,</em>
<a name="167" href="#167">167</a> <em>     *        !=, LIKE, etc.</em>
<a name="168" href="#168">168</a> <em>     * @param ignoreCase If true and columns represent Strings, the appropriate</em>
<a name="169" href="#169">169</a> <em>     *        function defined for the database will be used to ignore</em>
<a name="170" href="#170">170</a> <em>     *        differences in case.</em>
<a name="171" href="#171">171</a> <em>     * @param db Represents the database in use, for vendor specific functions.</em>
<a name="172" href="#172">172</a> <em>     * @return A simple sql expression, e.g. UPPER(table_a.column_a)</em>
<a name="173" href="#173">173</a> <em>     *         LIKE UPPER('ab%c').</em>
<a name="174" href="#174">174</a> <em>     * @throws TorqueException Any exceptions caught during processing will be</em>
<a name="175" href="#175">175</a> <em>     *         rethrown wrapped into a TorqueException.</em>
<a name="176" href="#176">176</a> <em>     */</em>
<a name="177" href="#177">177</a>     <strong>public</strong> <strong>static</strong> String build(String columnName,
<a name="178" href="#178">178</a>                                 Object criteria,
<a name="179" href="#179">179</a>                                 <a href="../../../../org/apache/torque/util/SqlEnum.html">SqlEnum</a> comparison,
<a name="180" href="#180">180</a>                                 <strong>boolean</strong> ignoreCase,
<a name="181" href="#181">181</a>                                 <a href="../../../../org/apache/torque/adapter/DB.html">DB</a> db)
<a name="182" href="#182">182</a>         throws <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>
<a name="183" href="#183">183</a>     {
<a name="184" href="#184">184</a>         <strong>int</strong> addlength = (ignoreCase ? 40 : 20);
<a name="185" href="#185">185</a>         StringBuffer sb = <strong>new</strong> StringBuffer(columnName.length() + addlength);
<a name="186" href="#186">186</a>         build(columnName, criteria, comparison, ignoreCase, db, sb);
<a name="187" href="#187">187</a>         <strong>return</strong> sb.toString();
<a name="188" href="#188">188</a>     }
<a name="189" href="#189">189</a> 
<a name="190" href="#190">190</a>     <em>/**<em>*</em></em>
<a name="191" href="#191">191</a> <em>     * Builds a simple SQL expression.</em>
<a name="192" href="#192">192</a> <em>     *</em>
<a name="193" href="#193">193</a> <em>     * @param columnName A column.</em>
<a name="194" href="#194">194</a> <em>     * @param criteria The value to compare the column against.</em>
<a name="195" href="#195">195</a> <em>     * @param comparison One of =, &amp;lt;, &amp;gt;, ^lt;=, &amp;gt;=, &amp;lt;&amp;gt;,</em>
<a name="196" href="#196">196</a> <em>     *        !=, LIKE, etc.</em>
<a name="197" href="#197">197</a> <em>     * @param ignoreCase If true and columns represent Strings, the appropriate</em>
<a name="198" href="#198">198</a> <em>     *        function defined for the database will be used to ignore</em>
<a name="199" href="#199">199</a> <em>     *        differences in case.</em>
<a name="200" href="#200">200</a> <em>     * @param db Represents the database in use, for vendor specific functions.</em>
<a name="201" href="#201">201</a> <em>     * @param whereClause A StringBuffer to which the sql expression will be</em>
<a name="202" href="#202">202</a> <em>     *        appended.</em>
<a name="203" href="#203">203</a> <em>     */</em>
<a name="204" href="#204">204</a>     <strong>public</strong> <strong>static</strong> <strong>void</strong> build(String columnName,
<a name="205" href="#205">205</a>                               Object criteria,
<a name="206" href="#206">206</a>                               <a href="../../../../org/apache/torque/util/SqlEnum.html">SqlEnum</a> comparison,
<a name="207" href="#207">207</a>                               <strong>boolean</strong> ignoreCase,
<a name="208" href="#208">208</a>                               <a href="../../../../org/apache/torque/adapter/DB.html">DB</a> db,
<a name="209" href="#209">209</a>                               StringBuffer whereClause)
<a name="210" href="#210">210</a>             throws <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>
<a name="211" href="#211">211</a>     {
<a name="212" href="#212">212</a>         <em class="comment">// Allow null criteria</em>
<a name="213" href="#213">213</a>         <em class="comment">// This will result in queries like</em>
<a name="214" href="#214">214</a>         <em class="comment">// insert into table (name, parent) values ('x', null);</em>
<a name="215" href="#215">215</a>         <em class="comment">//</em>
<a name="216" href="#216">216</a> 
<a name="217" href="#217">217</a>         <em class="comment">/*<em class="comment"> Check to see if the criteria is an ObjectKey</em></em>
<a name="218" href="#218">218</a> <em class="comment">         * and if the value of that ObjectKey is null.</em>
<a name="219" href="#219">219</a> <em class="comment">         * In that case, criteria should be null.</em>
<a name="220" href="#220">220</a> <em class="comment">         */</em>
<a name="221" href="#221">221</a> 
<a name="222" href="#222">222</a>         <strong>if</strong> (criteria != <strong>null</strong> &amp;&amp; criteria instanceof ObjectKey)
<a name="223" href="#223">223</a>         {
<a name="224" href="#224">224</a>             <strong>if</strong> (((ObjectKey) criteria).getValue() == <strong>null</strong>)
<a name="225" href="#225">225</a>             {
<a name="226" href="#226">226</a>                 criteria = <strong>null</strong>;
<a name="227" href="#227">227</a>             }
<a name="228" href="#228">228</a>         }
<a name="229" href="#229">229</a>         <em class="comment">/*<em class="comment">  If the criteria is null, check to see comparison</em></em>
<a name="230" href="#230">230</a> <em class="comment">         *  is an =, &lt;>, or !=.  If so, replace the comparison</em>
<a name="231" href="#231">231</a> <em class="comment">         *  with the proper IS or IS NOT.</em>
<a name="232" href="#232">232</a> <em class="comment">         */</em>
<a name="233" href="#233">233</a> 
<a name="234" href="#234">234</a>         <strong>if</strong> (criteria == <strong>null</strong>)
<a name="235" href="#235">235</a>         {
<a name="236" href="#236">236</a>             criteria = <span class="string">"null"</span>;
<a name="237" href="#237">237</a>             <strong>if</strong> (comparison.equals(Criteria.EQUAL))
<a name="238" href="#238">238</a>             {
<a name="239" href="#239">239</a>                 comparison = Criteria.ISNULL;
<a name="240" href="#240">240</a>             }
<a name="241" href="#241">241</a>             <strong>else</strong> <strong>if</strong> (comparison.equals(Criteria.NOT_EQUAL))
<a name="242" href="#242">242</a>             {
<a name="243" href="#243">243</a>                 comparison = Criteria.ISNOTNULL;
<a name="244" href="#244">244</a>             }
<a name="245" href="#245">245</a>             <strong>else</strong> <strong>if</strong> (comparison.equals(Criteria.ALT_NOT_EQUAL))
<a name="246" href="#246">246</a>             {
<a name="247" href="#247">247</a>                 comparison = Criteria.ISNOTNULL;
<a name="248" href="#248">248</a>             }
<a name="249" href="#249">249</a>         }
<a name="250" href="#250">250</a>         <strong>else</strong>
<a name="251" href="#251">251</a>         {
<a name="252" href="#252">252</a>             <strong>if</strong> (criteria instanceof String || criteria instanceof StringKey)
<a name="253" href="#253">253</a>             {
<a name="254" href="#254">254</a>                 criteria = quoteAndEscapeText(criteria.toString(), db);
<a name="255" href="#255">255</a>             }
<a name="256" href="#256">256</a>             <strong>else</strong> <strong>if</strong> (criteria instanceof Date)
<a name="257" href="#257">257</a>             {
<a name="258" href="#258">258</a>                 Date dt = (Date) criteria;
<a name="259" href="#259">259</a>                 criteria = db.getDateString(dt);
<a name="260" href="#260">260</a>             }
<a name="261" href="#261">261</a>             <strong>else</strong> <strong>if</strong> (criteria instanceof DateKey)
<a name="262" href="#262">262</a>             {
<a name="263" href="#263">263</a>                 Date dt = (Date) ((DateKey) criteria).getValue();
<a name="264" href="#264">264</a>                 criteria = db.getDateString(dt);
<a name="265" href="#265">265</a>             }
<a name="266" href="#266">266</a>             <strong>else</strong> <strong>if</strong> (criteria instanceof Boolean)
<a name="267" href="#267">267</a>             {
<a name="268" href="#268">268</a>                 criteria = db.getBooleanString((Boolean) criteria);
<a name="269" href="#269">269</a>             }
<a name="270" href="#270">270</a>             <strong>else</strong> <strong>if</strong> (criteria instanceof Criteria)
<a name="271" href="#271">271</a>             {
<a name="272" href="#272">272</a>                  <a href="../../../../org/apache/torque/util/Query.html">Query</a> subquery = SQLBuilder.buildQueryClause(
<a name="273" href="#273">273</a>                         (<a href="../../../../org/apache/torque/util/Criteria.html">Criteria</a>) criteria,
<a name="274" href="#274">274</a>                         <strong>null</strong>,
<a name="275" href="#275">275</a>                         <strong>new</strong> SQLBuilder.QueryCallback() {
<a name="276" href="#276">276</a>                             <strong>public</strong> String process(
<a name="277" href="#277">277</a>                                     Criteria.Criterion criterion,
<a name="278" href="#278">278</a>                                     List params)
<a name="279" href="#279">279</a>                             {
<a name="280" href="#280">280</a>                                 <strong>return</strong> criterion.toString();
<a name="281" href="#281">281</a>                             }
<a name="282" href="#282">282</a>                 });
<a name="283" href="#283">283</a>                 <strong>if</strong> (comparison.equals(Criteria.IN)
<a name="284" href="#284">284</a>                         || comparison.equals(Criteria.NOT_IN))
<a name="285" href="#285">285</a>                 {
<a name="286" href="#286">286</a>                     <em class="comment">// code below takes care of adding brackets</em>
<a name="287" href="#287">287</a>                     criteria = subquery.toString();
<a name="288" href="#288">288</a>                 }
<a name="289" href="#289">289</a>                 <strong>else</strong>
<a name="290" href="#290">290</a>                 {
<a name="291" href="#291">291</a>                     criteria = <span class="string">"("</span> + subquery.toString() + <span class="string">")"</span>;
<a name="292" href="#292">292</a>                 }
<a name="293" href="#293">293</a>             }
<a name="294" href="#294">294</a>         }
<a name="295" href="#295">295</a> 
<a name="296" href="#296">296</a>         <strong>if</strong> (comparison.equals(Criteria.LIKE)
<a name="297" href="#297">297</a>                 || comparison.equals(Criteria.NOT_LIKE)
<a name="298" href="#298">298</a>                 || comparison.equals(Criteria.ILIKE)
<a name="299" href="#299">299</a>                 || comparison.equals(Criteria.NOT_ILIKE))
<a name="300" href="#300">300</a>         {
<a name="301" href="#301">301</a>             buildLike(columnName, (String) criteria, comparison,
<a name="302" href="#302">302</a>                        ignoreCase, db, whereClause);
<a name="303" href="#303">303</a>         }
<a name="304" href="#304">304</a>         <strong>else</strong> <strong>if</strong> (comparison.equals(Criteria.IN)
<a name="305" href="#305">305</a>                 || comparison.equals(Criteria.NOT_IN))
<a name="306" href="#306">306</a>         {
<a name="307" href="#307">307</a>             buildIn(columnName, criteria, comparison,
<a name="308" href="#308">308</a>                      ignoreCase, db, whereClause);
<a name="309" href="#309">309</a>         }
<a name="310" href="#310">310</a>         <strong>else</strong>
<a name="311" href="#311">311</a>         {
<a name="312" href="#312">312</a>             <em class="comment">// Do not put the upper/lower keyword around IS NULL</em>
<a name="313" href="#313">313</a>             <em class="comment">//  or IS NOT NULL</em>
<a name="314" href="#314">314</a>             <strong>if</strong> (comparison.equals(Criteria.ISNULL)
<a name="315" href="#315">315</a>                     || comparison.equals(Criteria.ISNOTNULL))
<a name="316" href="#316">316</a>             {
<a name="317" href="#317">317</a>                 whereClause.append(columnName)
<a name="318" href="#318">318</a>                         .append(comparison);
<a name="319" href="#319">319</a>             }
<a name="320" href="#320">320</a>             <strong>else</strong>
<a name="321" href="#321">321</a>             {
<a name="322" href="#322">322</a>                 String columnValue = criteria.toString();
<a name="323" href="#323">323</a>                 <strong>if</strong> (ignoreCase &amp;&amp; db != <strong>null</strong>)
<a name="324" href="#324">324</a>                 {
<a name="325" href="#325">325</a>                     columnName = db.ignoreCase(columnName);
<a name="326" href="#326">326</a>                     columnValue = db.ignoreCase(columnValue);
<a name="327" href="#327">327</a>                 }
<a name="328" href="#328">328</a>                 whereClause.append(columnName)
<a name="329" href="#329">329</a>                         .append(comparison)
<a name="330" href="#330">330</a>                         .append(columnValue);
<a name="331" href="#331">331</a>             }
<a name="332" href="#332">332</a>         }
<a name="333" href="#333">333</a>     }
<a name="334" href="#334">334</a> 
<a name="335" href="#335">335</a>     <em>/**<em>*</em></em>
<a name="336" href="#336">336</a> <em>     * Takes a columnName and criteria and builds an SQL phrase based</em>
<a name="337" href="#337">337</a> <em>     * on whether wildcards are present and the state of the</em>
<a name="338" href="#338">338</a> <em>     * ignoreCase flag.  Multicharacter wildcards % and * may be used</em>
<a name="339" href="#339">339</a> <em>     * as well as single character wildcards, _ and ?.  These</em>
<a name="340" href="#340">340</a> <em>     * characters can be escaped with \.</em>
<a name="341" href="#341">341</a> <em>     *</em>
<a name="342" href="#342">342</a> <em>     * e.g. criteria = "fre%" -> columnName LIKE 'fre%'</em>
<a name="343" href="#343">343</a> <em>     *                        -> UPPER(columnName) LIKE UPPER('fre%')</em>
<a name="344" href="#344">344</a> <em>     *      criteria = "50\%" -> columnName = '50%'</em>
<a name="345" href="#345">345</a> <em>     *</em>
<a name="346" href="#346">346</a> <em>     * @param columnName A column.</em>
<a name="347" href="#347">347</a> <em>     * @param criteria The value to compare the column against.</em>
<a name="348" href="#348">348</a> <em>     * @param comparison Whether to do a LIKE or a NOT LIKE</em>
<a name="349" href="#349">349</a> <em>     * @param ignoreCase If true and columns represent Strings, the</em>
<a name="350" href="#350">350</a> <em>     * appropriate function defined for the database will be used to</em>
<a name="351" href="#351">351</a> <em>     * ignore differences in case.</em>
<a name="352" href="#352">352</a> <em>     * @param db Represents the database in use, for vendor specific functions.</em>
<a name="353" href="#353">353</a> <em>     * @return An SQL expression.</em>
<a name="354" href="#354">354</a> <em>     */</em>
<a name="355" href="#355">355</a>     <strong>static</strong> String buildLike(String columnName,
<a name="356" href="#356">356</a>                              String criteria,
<a name="357" href="#357">357</a>                              <a href="../../../../org/apache/torque/util/SqlEnum.html">SqlEnum</a> comparison,
<a name="358" href="#358">358</a>                              <strong>boolean</strong> ignoreCase,
<a name="359" href="#359">359</a>                              <a href="../../../../org/apache/torque/adapter/DB.html">DB</a> db)
<a name="360" href="#360">360</a>     {
<a name="361" href="#361">361</a>         StringBuffer whereClause = <strong>new</strong> StringBuffer();
<a name="362" href="#362">362</a>         buildLike(columnName, criteria, comparison, ignoreCase, db,
<a name="363" href="#363">363</a>                    whereClause);
<a name="364" href="#364">364</a>         <strong>return</strong> whereClause.toString();
<a name="365" href="#365">365</a>     }
<a name="366" href="#366">366</a> 
<a name="367" href="#367">367</a>     <em>/**<em>*</em></em>
<a name="368" href="#368">368</a> <em>     * Takes a columnName and criteria and builds an SQL phrase based</em>
<a name="369" href="#369">369</a> <em>     * on whether wildcards are present and the state of the</em>
<a name="370" href="#370">370</a> <em>     * ignoreCase flag.  Multicharacter wildcards % and * may be used</em>
<a name="371" href="#371">371</a> <em>     * as well as single character wildcards, _ and ?.  These</em>
<a name="372" href="#372">372</a> <em>     * characters can be escaped with \.</em>
<a name="373" href="#373">373</a> <em>     *</em>
<a name="374" href="#374">374</a> <em>     * e.g. criteria = "fre%" -> columnName LIKE 'fre%'</em>
<a name="375" href="#375">375</a> <em>     *                        -> UPPER(columnName) LIKE UPPER('fre%')</em>
<a name="376" href="#376">376</a> <em>     *      criteria = "50\%" -> columnName = '50%'</em>
<a name="377" href="#377">377</a> <em>     *</em>
<a name="378" href="#378">378</a> <em>     * @param columnName A column name.</em>
<a name="379" href="#379">379</a> <em>     * @param criteria The value to compare the column against.</em>
<a name="380" href="#380">380</a> <em>     * @param comparison Whether to do a LIKE or a NOT LIKE</em>
<a name="381" href="#381">381</a> <em>     * @param ignoreCase If true and columns represent Strings, the</em>
<a name="382" href="#382">382</a> <em>     * appropriate function defined for the database will be used to</em>
<a name="383" href="#383">383</a> <em>     * ignore differences in case.</em>
<a name="384" href="#384">384</a> <em>     * @param db Represents the database in use, for vendor specific functions.</em>
<a name="385" href="#385">385</a> <em>     * @param whereClause A StringBuffer to which the sql expression</em>
<a name="386" href="#386">386</a> <em>     * will be appended.</em>
<a name="387" href="#387">387</a> <em>     */</em>
<a name="388" href="#388">388</a>     <strong>static</strong> <strong>void</strong> buildLike(String columnName,
<a name="389" href="#389">389</a>                            String criteria,
<a name="390" href="#390">390</a>                            <a href="../../../../org/apache/torque/util/SqlEnum.html">SqlEnum</a> comparison,
<a name="391" href="#391">391</a>                            <strong>boolean</strong> ignoreCase,
<a name="392" href="#392">392</a>                            <a href="../../../../org/apache/torque/adapter/DB.html">DB</a> db,
<a name="393" href="#393">393</a>                            StringBuffer whereClause)
<a name="394" href="#394">394</a>     {
<a name="395" href="#395">395</a>         <em class="comment">// If selection criteria contains wildcards use LIKE otherwise</em>
<a name="396" href="#396">396</a>         <em class="comment">// use = (equals).  Wildcards can be escaped by prepending</em>
<a name="397" href="#397">397</a>         <em class="comment">// them with \ (backslash). However, if we switch from</em>
<a name="398" href="#398">398</a>         <em class="comment">// like to equals, we need to remove the escape characters.</em>
<a name="399" href="#399">399</a>         <em class="comment">// from the wildcards.</em>
<a name="400" href="#400">400</a>         <em class="comment">// So we need two passes: The first replaces * and ? by % and _,</em>
<a name="401" href="#401">401</a>         <em class="comment">// and checks whether we switch to equals,</em>
<a name="402" href="#402">402</a>         <em class="comment">// the second removes escapes if we have switched to equals.</em>
<a name="403" href="#403">403</a>         <strong>int</strong> position = 0;
<a name="404" href="#404">404</a>         StringBuffer sb = <strong>new</strong> StringBuffer();
<a name="405" href="#405">405</a>         <strong>boolean</strong> replaceWithEquals = <strong>true</strong>;
<a name="406" href="#406">406</a>         <strong>while</strong> (position &lt; criteria.length())
<a name="407" href="#407">407</a>         {
<a name="408" href="#408">408</a>             <strong>char</strong> checkWildcard = criteria.<strong>char</strong>At(position);
<a name="409" href="#409">409</a> 
<a name="410" href="#410">410</a>             <strong>switch</strong> (checkWildcard)
<a name="411" href="#411">411</a>             {
<a name="412" href="#412">412</a>             <strong>case</strong> BACKSLASH:
<a name="413" href="#413">413</a>                 <em class="comment">// if text is escaped, all backslashes are already escaped,</em>
<a name="414" href="#414">414</a>                 <em class="comment">// so the next character after the backslash is the doubled</em>
<a name="415" href="#415">415</a>                 <em class="comment">// backslash from escaping.</em>
<a name="416" href="#416">416</a>                 <strong>int</strong> charsToProceed = db.escapeText() ? 2 : 1;
<a name="417" href="#417">417</a>                 <strong>if</strong> (position + charsToProceed >= criteria.length())
<a name="418" href="#418">418</a>                 {
<a name="419" href="#419">419</a>                     charsToProceed = criteria.length() - position - 1;
<a name="420" href="#420">420</a>                 }
<a name="421" href="#421">421</a>                 <strong>else</strong> <strong>if</strong> (criteria.charAt(position + charsToProceed) == BACKSLASH
<a name="422" href="#422">422</a>                         &amp;&amp; db.escapeText())
<a name="423" href="#423">423</a>                 {
<a name="424" href="#424">424</a>                     <em class="comment">// the escaped backslash is also escaped,</em>
<a name="425" href="#425">425</a>                     <em class="comment">// so we need to proceed another character</em>
<a name="426" href="#426">426</a>                     charsToProceed += 1;
<a name="427" href="#427">427</a>                 }
<a name="428" href="#428">428</a>                 sb.append(criteria.substring(
<a name="429" href="#429">429</a>                         position,
<a name="430" href="#430">430</a>                         position + charsToProceed));
<a name="431" href="#431">431</a>                 position += charsToProceed;
<a name="432" href="#432">432</a>                 <em class="comment">// code below copies escaped character into sb</em>
<a name="433" href="#433">433</a>                 checkWildcard = criteria.charAt(position);
<a name="434" href="#434">434</a>                 <strong>break</strong>;
<a name="435" href="#435">435</a>             <strong>case</strong> '%':
<a name="436" href="#436">436</a>             <strong>case</strong> '_':
<a name="437" href="#437">437</a>                 replaceWithEquals = false;
<a name="438" href="#438">438</a>                 <strong>break</strong>;
<a name="439" href="#439">439</a>             <strong>case</strong> '*':
<a name="440" href="#440">440</a>                 replaceWithEquals = false;
<a name="441" href="#441">441</a>                 checkWildcard = '%';
<a name="442" href="#442">442</a>                 <strong>break</strong>;
<a name="443" href="#443">443</a>             <strong>case</strong> '?':
<a name="444" href="#444">444</a>                 replaceWithEquals = false;
<a name="445" href="#445">445</a>                 checkWildcard = '_';
<a name="446" href="#446">446</a>                 <strong>break</strong>;
<a name="447" href="#447">447</a>             }
<a name="448" href="#448">448</a> 
<a name="449" href="#449">449</a>             sb.append(checkWildcard);
<a name="450" href="#450">450</a>             position++;
<a name="451" href="#451">451</a>         }
<a name="452" href="#452">452</a>         criteria = sb.toString();
<a name="453" href="#453">453</a> 
<a name="454" href="#454">454</a>         <strong>if</strong> (ignoreCase)
<a name="455" href="#455">455</a>         {
<a name="456" href="#456">456</a>             <strong>if</strong> (db.useIlike() &amp;&amp; !replaceWithEquals)
<a name="457" href="#457">457</a>             {
<a name="458" href="#458">458</a>                 <strong>if</strong> (SqlEnum.LIKE.equals(comparison))
<a name="459" href="#459">459</a>                 {
<a name="460" href="#460">460</a>                     comparison = SqlEnum.ILIKE;
<a name="461" href="#461">461</a>                 }
<a name="462" href="#462">462</a>                 <strong>else</strong> <strong>if</strong> (SqlEnum.NOT_LIKE.equals(comparison))
<a name="463" href="#463">463</a>                 {
<a name="464" href="#464">464</a>                     comparison = SqlEnum.NOT_ILIKE;
<a name="465" href="#465">465</a>                 }
<a name="466" href="#466">466</a>             }
<a name="467" href="#467">467</a>             <strong>else</strong>
<a name="468" href="#468">468</a>             {
<a name="469" href="#469">469</a>                 <em class="comment">// no native case insensitive like is offered by the DB,</em>
<a name="470" href="#470">470</a>                 <em class="comment">// or the LIKE was replaced with equals.</em>
<a name="471" href="#471">471</a>                 <em class="comment">// need to ignore case manually.</em>
<a name="472" href="#472">472</a>                 columnName = db.ignoreCase(columnName);
<a name="473" href="#473">473</a>             }
<a name="474" href="#474">474</a>         }
<a name="475" href="#475">475</a>         whereClause.append(columnName);
<a name="476" href="#476">476</a> 
<a name="477" href="#477">477</a>         <strong>if</strong> (replaceWithEquals)
<a name="478" href="#478">478</a>         {
<a name="479" href="#479">479</a>             <strong>if</strong> (comparison.equals(Criteria.NOT_LIKE)
<a name="480" href="#480">480</a>                     || comparison.equals(Criteria.NOT_ILIKE))
<a name="481" href="#481">481</a>             {
<a name="482" href="#482">482</a>                 whereClause.append(<span class="string">" "</span>).append(Criteria.NOT_EQUAL).append(<span class="string">" "</span>);
<a name="483" href="#483">483</a>             }
<a name="484" href="#484">484</a>             <strong>else</strong>
<a name="485" href="#485">485</a>             {
<a name="486" href="#486">486</a>                 whereClause.append(<span class="string">" "</span>).append(Criteria.EQUAL).append(<span class="string">" "</span>);
<a name="487" href="#487">487</a>             }
<a name="488" href="#488">488</a> 
<a name="489" href="#489">489</a>             <em class="comment">// remove escape backslashes from String</em>
<a name="490" href="#490">490</a>             position = 0;
<a name="491" href="#491">491</a>             sb = <strong>new</strong> StringBuffer();
<a name="492" href="#492">492</a>             <strong>while</strong> (position &lt; criteria.length())
<a name="493" href="#493">493</a>             {
<a name="494" href="#494">494</a>                 <strong>char</strong> checkWildcard = criteria.<strong>char</strong>At(position);
<a name="495" href="#495">495</a> 
<a name="496" href="#496">496</a>                 <strong>if</strong> (checkWildcard == BACKSLASH)
<a name="497" href="#497">497</a>                 {
<a name="498" href="#498">498</a>                     <em class="comment">// if text is escaped, all backslashes are already escaped,</em>
<a name="499" href="#499">499</a>                     <em class="comment">// so the next character after the backslash is the doubled</em>
<a name="500" href="#500">500</a>                     <em class="comment">// backslash from escaping.</em>
<a name="501" href="#501">501</a>                     <strong>int</strong> charsToSkip = db.escapeText() ? 2 : 1;
<a name="502" href="#502">502</a>                     <strong>if</strong> (position + charsToSkip >= criteria.length())
<a name="503" href="#503">503</a>                     {
<a name="504" href="#504">504</a>                         charsToSkip = criteria.length() - position - 1;
<a name="505" href="#505">505</a>                     }
<a name="506" href="#506">506</a>                     <strong>else</strong> <strong>if</strong> (criteria.charAt(position + charsToSkip)
<a name="507" href="#507">507</a>                                 == BACKSLASH
<a name="508" href="#508">508</a>                             &amp;&amp; db.escapeText())
<a name="509" href="#509">509</a>                     {
<a name="510" href="#510">510</a>                         <em class="comment">// the escaped backslash is also escaped,</em>
<a name="511" href="#511">511</a>                         <em class="comment">// so we need to skip another character</em>
<a name="512" href="#512">512</a>                         <em class="comment">// but add the escaped backslash to sb</em>
<a name="513" href="#513">513</a>                         <em class="comment">// so that the escaping remains.</em>
<a name="514" href="#514">514</a>                         sb.append(BACKSLASH);
<a name="515" href="#515">515</a>                         charsToSkip += 1;
<a name="516" href="#516">516</a>                     }
<a name="517" href="#517">517</a>                     position += charsToSkip;
<a name="518" href="#518">518</a>                     <em class="comment">// code below copies escaped character into sb</em>
<a name="519" href="#519">519</a>                     checkWildcard = criteria.charAt(position);
<a name="520" href="#520">520</a>                 }
<a name="521" href="#521">521</a>                 sb.append(checkWildcard);
<a name="522" href="#522">522</a>                 position++;
<a name="523" href="#523">523</a>             }
<a name="524" href="#524">524</a>             criteria = sb.toString();
<a name="525" href="#525">525</a>        }
<a name="526" href="#526">526</a>         <strong>else</strong>
<a name="527" href="#527">527</a>         {
<a name="528" href="#528">528</a>             whereClause.append(comparison);
<a name="529" href="#529">529</a>         }
<a name="530" href="#530">530</a> 
<a name="531" href="#531">531</a>         <em class="comment">// If selection is case insensitive use SQL UPPER() function</em>
<a name="532" href="#532">532</a>         <em class="comment">// on criteria.</em>
<a name="533" href="#533">533</a>         <strong>if</strong> (ignoreCase &amp;&amp; (!(db.useIlike()) || replaceWithEquals))
<a name="534" href="#534">534</a>         {
<a name="535" href="#535">535</a>             criteria = db.ignoreCase(criteria);
<a name="536" href="#536">536</a>         }
<a name="537" href="#537">537</a>         whereClause.append(criteria);
<a name="538" href="#538">538</a> 
<a name="539" href="#539">539</a>         <strong>if</strong> (!replaceWithEquals &amp;&amp; db.useEscapeClauseForLike())
<a name="540" href="#540">540</a>         {
<a name="541" href="#541">541</a>             whereClause.append(SqlEnum.ESCAPE)
<a name="542" href="#542">542</a>                        .append(<span class="string">"'&#47;&#47;'"</span>);
<a name="543" href="#543">543</a>         }
<a name="544" href="#544">544</a>     }
<a name="545" href="#545">545</a> 
<a name="546" href="#546">546</a>     <em>/**<em>*</em></em>
<a name="547" href="#547">547</a> <em>     * Takes a columnName and criteria (which must be an array) and</em>
<a name="548" href="#548">548</a> <em>     * builds a SQL 'IN' expression taking into account the ignoreCase</em>
<a name="549" href="#549">549</a> <em>     * flag.</em>
<a name="550" href="#550">550</a> <em>     *</em>
<a name="551" href="#551">551</a> <em>     * @param columnName A column.</em>
<a name="552" href="#552">552</a> <em>     * @param criteria The value to compare the column against.</em>
<a name="553" href="#553">553</a> <em>     * @param comparison Either " IN " or " NOT IN ".</em>
<a name="554" href="#554">554</a> <em>     * @param ignoreCase If true and columns represent Strings, the</em>
<a name="555" href="#555">555</a> <em>     * appropriate function defined for the database will be used to</em>
<a name="556" href="#556">556</a> <em>     * ignore differences in case.</em>
<a name="557" href="#557">557</a> <em>     * @param db Represents the database in use, for vendor specific functions.</em>
<a name="558" href="#558">558</a> <em>     * @return An SQL expression.</em>
<a name="559" href="#559">559</a> <em>     */</em>
<a name="560" href="#560">560</a>     <strong>static</strong> String buildIn(String columnName,
<a name="561" href="#561">561</a>                           Object criteria,
<a name="562" href="#562">562</a>                           <a href="../../../../org/apache/torque/util/SqlEnum.html">SqlEnum</a> comparison,
<a name="563" href="#563">563</a>                           <strong>boolean</strong> ignoreCase,
<a name="564" href="#564">564</a>                           <a href="../../../../org/apache/torque/adapter/DB.html">DB</a> db)
<a name="565" href="#565">565</a>     {
<a name="566" href="#566">566</a>         StringBuffer whereClause = <strong>new</strong> StringBuffer();
<a name="567" href="#567">567</a>         buildIn(columnName, criteria, comparison,
<a name="568" href="#568">568</a>                 ignoreCase, db, whereClause);
<a name="569" href="#569">569</a>         <strong>return</strong> whereClause.toString();
<a name="570" href="#570">570</a>     }
<a name="571" href="#571">571</a> 
<a name="572" href="#572">572</a>     <em>/**<em>*</em></em>
<a name="573" href="#573">573</a> <em>     * Takes a columnName and criteria (which must be an array) and</em>
<a name="574" href="#574">574</a> <em>     * builds a SQL 'IN' expression taking into account the ignoreCase</em>
<a name="575" href="#575">575</a> <em>     * flag.</em>
<a name="576" href="#576">576</a> <em>     *</em>
<a name="577" href="#577">577</a> <em>     * @param columnName A column.</em>
<a name="578" href="#578">578</a> <em>     * @param criteria The value to compare the column against.</em>
<a name="579" href="#579">579</a> <em>     * @param comparison Either " IN " or " NOT IN ".</em>
<a name="580" href="#580">580</a> <em>     * @param ignoreCase If true and columns represent Strings, the</em>
<a name="581" href="#581">581</a> <em>     * appropriate function defined for the database will be used to</em>
<a name="582" href="#582">582</a> <em>     * ignore differences in case.</em>
<a name="583" href="#583">583</a> <em>     * @param db Represents the database in use, for vendor specific functions.</em>
<a name="584" href="#584">584</a> <em>     * @param whereClause A StringBuffer to which the sql expression</em>
<a name="585" href="#585">585</a> <em>     * will be appended.</em>
<a name="586" href="#586">586</a> <em>     */</em>
<a name="587" href="#587">587</a>     <strong>static</strong> <strong>void</strong> buildIn(String columnName,
<a name="588" href="#588">588</a>                         Object criteria,
<a name="589" href="#589">589</a>                         <a href="../../../../org/apache/torque/util/SqlEnum.html">SqlEnum</a> comparison,
<a name="590" href="#590">590</a>                         <strong>boolean</strong> ignoreCase,
<a name="591" href="#591">591</a>                         <a href="../../../../org/apache/torque/adapter/DB.html">DB</a> db,
<a name="592" href="#592">592</a>                         StringBuffer whereClause)
<a name="593" href="#593">593</a>     {
<a name="594" href="#594">594</a>         <strong>if</strong> (ignoreCase)
<a name="595" href="#595">595</a>         {
<a name="596" href="#596">596</a>             whereClause.append(db.ignoreCase(columnName));
<a name="597" href="#597">597</a>         }
<a name="598" href="#598">598</a>         <strong>else</strong>
<a name="599" href="#599">599</a>         {
<a name="600" href="#600">600</a>             whereClause.append(columnName);
<a name="601" href="#601">601</a>         }
<a name="602" href="#602">602</a> 
<a name="603" href="#603">603</a>         whereClause.append(comparison);
<a name="604" href="#604">604</a>         HashSet inClause = <strong>new</strong> HashSet();
<a name="605" href="#605">605</a>         <strong>if</strong> (criteria instanceof List)
<a name="606" href="#606">606</a>         {
<a name="607" href="#607">607</a>             Iterator iter = ((List) criteria).iterator();
<a name="608" href="#608">608</a>             <strong>while</strong> (iter.hasNext())
<a name="609" href="#609">609</a>             {
<a name="610" href="#610">610</a>                 Object value = iter.next();
<a name="611" href="#611">611</a> 
<a name="612" href="#612">612</a>                 <em class="comment">// The method processInValue() quotes the string</em>
<a name="613" href="#613">613</a>                 <em class="comment">// and/or wraps it in UPPER().</em>
<a name="614" href="#614">614</a>                 inClause.add(processInValue(value, ignoreCase, db));
<a name="615" href="#615">615</a>             }
<a name="616" href="#616">616</a>         }
<a name="617" href="#617">617</a>         <strong>else</strong> <strong>if</strong> (criteria instanceof String)
<a name="618" href="#618">618</a>         {
<a name="619" href="#619">619</a>             <em class="comment">// subquery</em>
<a name="620" href="#620">620</a>             inClause.add(criteria);
<a name="621" href="#621">621</a>         }
<a name="622" href="#622">622</a>         <strong>else</strong>
<a name="623" href="#623">623</a>         {
<a name="624" href="#624">624</a>             <em class="comment">// Assume array.</em>
<a name="625" href="#625">625</a>             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; Array.getLength(criteria); i++)
<a name="626" href="#626">626</a>             {
<a name="627" href="#627">627</a>                 Object value = Array.get(criteria, i);
<a name="628" href="#628">628</a> 
<a name="629" href="#629">629</a>                 <em class="comment">// The method processInValue() quotes the string</em>
<a name="630" href="#630">630</a>                 <em class="comment">// and/or wraps it in UPPER().</em>
<a name="631" href="#631">631</a>                 inClause.add(processInValue(value, ignoreCase, db));
<a name="632" href="#632">632</a>             }
<a name="633" href="#633">633</a>         }
<a name="634" href="#634">634</a>         whereClause.append('(')
<a name="635" href="#635">635</a>                    .append(StringUtils.join(inClause.iterator(), <span class="string">","</span>))
<a name="636" href="#636">636</a>                    .append(')');
<a name="637" href="#637">637</a>     }
<a name="638" href="#638">638</a> 
<a name="639" href="#639">639</a>     <em>/**<em>*</em></em>
<a name="640" href="#640">640</a> <em>     * Creates an appropriate string for an 'IN' clause from an</em>
<a name="641" href="#641">641</a> <em>     * object.  Adds quoting and/or UPPER() as appropriate.  This is</em>
<a name="642" href="#642">642</a> <em>     * broken out into a seperate method as it is used in two places</em>
<a name="643" href="#643">643</a> <em>     * in buildIn, depending on whether an array or List is being</em>
<a name="644" href="#644">644</a> <em>     * looped over.</em>
<a name="645" href="#645">645</a> <em>     *</em>
<a name="646" href="#646">646</a> <em>     * @param value The value to process.</em>
<a name="647" href="#647">647</a> <em>     * @param ignoreCase Coerce the value suitably for ignoring case.</em>
<a name="648" href="#648">648</a> <em>     * @param db Represents the database in use for vendor specific functions.</em>
<a name="649" href="#649">649</a> <em>     * @return Processed value as String.</em>
<a name="650" href="#650">650</a> <em>     */</em>
<a name="651" href="#651">651</a>     <strong>static</strong> String processInValue(Object value,
<a name="652" href="#652">652</a>                                  <strong>boolean</strong> ignoreCase,
<a name="653" href="#653">653</a>                                  <a href="../../../../org/apache/torque/adapter/DB.html">DB</a> db)
<a name="654" href="#654">654</a>     {
<a name="655" href="#655">655</a>         String ret = <strong>null</strong>;
<a name="656" href="#656">656</a>         <strong>if</strong> (value instanceof String)
<a name="657" href="#657">657</a>         {
<a name="658" href="#658">658</a>             ret = quoteAndEscapeText((String) value, db);
<a name="659" href="#659">659</a>         }
<a name="660" href="#660">660</a>         <strong>else</strong>
<a name="661" href="#661">661</a>         {
<a name="662" href="#662">662</a>             ret = value.toString();
<a name="663" href="#663">663</a>         }
<a name="664" href="#664">664</a>         <strong>if</strong> (ignoreCase)
<a name="665" href="#665">665</a>         {
<a name="666" href="#666">666</a>             ret = db.ignoreCase(ret);
<a name="667" href="#667">667</a>         }
<a name="668" href="#668">668</a>         <strong>return</strong> ret;
<a name="669" href="#669">669</a>     }
<a name="670" href="#670">670</a> 
<a name="671" href="#671">671</a>     <em>/**<em>*</em></em>
<a name="672" href="#672">672</a> <em>     * Quotes and escapes raw text for placement in a SQL expression.</em>
<a name="673" href="#673">673</a> <em>     * For simplicity, the text is assumed to be neither quoted nor</em>
<a name="674" href="#674">674</a> <em>     * escaped.</em>
<a name="675" href="#675">675</a> <em>     *</em>
<a name="676" href="#676">676</a> <em>     * @param rawText The &lt;i>unquoted&lt;/i>, &lt;i>unescaped&lt;/i> text to process.</em>
<a name="677" href="#677">677</a> <em>     * @param db the db</em>
<a name="678" href="#678">678</a> <em>     * @return Quoted and escaped text.</em>
<a name="679" href="#679">679</a> <em>     */</em>
<a name="680" href="#680">680</a>     <strong>public</strong> <strong>static</strong> String quoteAndEscapeText(String rawText, <a href="../../../../org/apache/torque/adapter/DB.html">DB</a> db)
<a name="681" href="#681">681</a>     {
<a name="682" href="#682">682</a>         StringBuffer buf = <strong>new</strong> StringBuffer((<strong>int</strong>) (rawText.length() * 1.1));
<a name="683" href="#683">683</a> 
<a name="684" href="#684">684</a>         <em class="comment">// Some databases do not need escaping.</em>
<a name="685" href="#685">685</a>         String escapeString;
<a name="686" href="#686">686</a>         <strong>if</strong> (db != <strong>null</strong> &amp;&amp; !db.escapeText())
<a name="687" href="#687">687</a>         {
<a name="688" href="#688">688</a>             escapeString = String.valueOf(BACKSLASH);
<a name="689" href="#689">689</a>         }
<a name="690" href="#690">690</a>         <strong>else</strong>
<a name="691" href="#691">691</a>         {
<a name="692" href="#692">692</a>             escapeString = String.valueOf(BACKSLASH)
<a name="693" href="#693">693</a>                     + String.valueOf(BACKSLASH);
<a name="694" href="#694">694</a>         }
<a name="695" href="#695">695</a> 
<a name="696" href="#696">696</a>         <strong>char</strong>[] data = rawText.toCharArray();
<a name="697" href="#697">697</a>         buf.append(SINGLE_QUOTE);
<a name="698" href="#698">698</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; data.length; i++)
<a name="699" href="#699">699</a>         {
<a name="700" href="#700">700</a>             <strong>switch</strong> (data[i])
<a name="701" href="#701">701</a>             {
<a name="702" href="#702">702</a>             <strong>case</strong> SINGLE_QUOTE:
<a name="703" href="#703">703</a>                 buf.append(SINGLE_QUOTE).append(SINGLE_QUOTE);
<a name="704" href="#704">704</a>                 <strong>break</strong>;
<a name="705" href="#705">705</a>             <strong>case</strong> BACKSLASH:
<a name="706" href="#706">706</a>                 buf.append(escapeString);
<a name="707" href="#707">707</a>                 <strong>break</strong>;
<a name="708" href="#708">708</a>             <strong>default</strong>:
<a name="709" href="#709">709</a>                 buf.append(data[i]);
<a name="710" href="#710">710</a>             }
<a name="711" href="#711">711</a>         }
<a name="712" href="#712">712</a>         buf.append(SINGLE_QUOTE);
<a name="713" href="#713">713</a> 
<a name="714" href="#714">714</a>         <strong>return</strong> buf.toString();
<a name="715" href="#715">715</a>     }
<a name="716" href="#716">716</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

